im context simple: Add documentation
authorMatthias Clasen <mclasen@redhat.com>
Fri, 9 Oct 2015 04:17:09 +0000 (00:17 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Fri, 9 Oct 2015 04:19:41 +0000 (00:19 -0400)
Document that GtkIMContextSimple is loading additional compose
tables. Also document Ctrl-Shift-u.

gtk/gtkimcontextsimple.c

index 03cc4515b42e1b566cd7a62abe7a5d5c022703d1..82c5221e64442d5edf5a2ec31fcf98169913c55a 100644 (file)
  * SECTION:gtkimcontextsimple
  * @Short_description: An input method context supporting table-based input methods
  * @Title: GtkIMContextSimple
+ *
+ * GtkIMContextSimple is a simple input method context supporting table-based
+ * input methods. It has a built-in table of compose sequences that is derived
+ * from the X11 Compose files.
+ *
+ * GtkIMContextSimple reads additional compose sequences from the first of the
+ * following files that is found: ~/.config/gtk-3.0/Compose, ~/.XCompose,
+ * /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial
+ * Compose file). The syntax of these files is described in the Compose(5)
+ * manual page.
+ *
+ * GtkIMContextSimple also supports numeric entry of Unicode characters
+ * by typing Ctrl-Shift-u, followed by a hexadecimal Unicode codepoint.
+ * For example, Ctrl-Shift-u 1 2 3 Enter yields U+0123 LATIN SMALL LETTER
+ * G WITH CEDILLA, i.e. ģ.
  */